system.widgets.KeyBoard

Widget Description

Properties

name description category type defaultValue bindable readOnly required localizable editableBinding projectable cssProp (has no setter and getter in JS) groupRefId groupOrder nodeRefId (for linking node and value) deprecated typeRefId (for StyleReference) subtype (for MpComIdentReference)
autoRaise Can be used to configure the behavior of raising a window above others when the user clicks on it. The default behavior will raise the window automaically when the user clicks on it brease.enum.AutoRaise enabled false false false false false true
enable Initial option to enable widget. Behavior Boolean true true false false false false true
modal If true, the window will be modal, in the meaning that no interaction with beneath page is possible. A semi transparent overlay between window and parent application will catch user actions. It depends on settings 'showCloseButton' and 'forceInteraction' how the user can close the window. Boolean true false false false false false true
permissionOperate restricts operability to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
permissionView restricts visibility to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
position Horizontal and vertical position of the Window. Either a string (horizontal:left/center/right, vertical:top/middle/bottom) or an integer. Example : 
  {'horizontal': 'center', 'vertical': 105}
Object {'horizontal':'center', 'vertical':'middle'} false false false false false true
style reference to a style for this widget type Appearance StyleReference default true false false false false true
tabIndex sets if a widget should have autofocus enabled (0), the order of the focus (>0), or if autofocus should be disabled (-1) Behavior Integer -1 false false false false false true
tooltip reference to a tooltip for a widget Appearance String false false false true false true
visible change visibility Behavior Boolean true true false false false false true
zIndex The zIndex property specifies the z-order of a widget and its childs.
When widgets overlap, z-order determines which one covers the other. A widget with a larger zIndex generally covers a widget with a lower one.
The zIndex must be unique within a content.
 UInteger no defaultValue
defined		 false false true true true
left absolute position measured from left boundary of parent container Integer no defaultValue
defined		 false false false true true
top absolute position measured from top boundary of parent container Integer no defaultValue
defined		 false false false true true
height outer height of widget Size 473 false false false true true
width outer width of widget Size 957 false false false true true

Events

name description arguments
DisabledClick Fired when disabled element is clicked on.
  • origin: String

    id of widget that triggered this event

  • hasPermission: Boolean

    defines if the state is caused due to missing roles of the current user

  • horizontalPos: String

    horizontal position of click in pixel i.e '10px'

  • verticalPos: String

    vertical position of click in pixel i.e '10px'

FocusIn Fired when the widgets gets focus
FocusOut Fired when the widgets lost focus

Actions

name description arguments result
Focus Sets focus on the widget element, if it can be focused and keyboardOperation=true
ShowTooltip